Correct formatting for TaskRun in Build docs #85708
Conversation
openshift-ci
bot
added
the
size/XS
|
🤖 Wed Dec 11 13:30:36 - Prow CI generated the docs preview: https://85708--ocpdocs-pr.netlify.app/openshift-builds/latest/about/overview-openshift-builds.html |
likhithj1996
force-pushed
the
RHDEVDOCS-6154
branch
from
7e3fb2f to
6f86341
Compare
|
/lgtm, thanks @likhithj1996. Kindly add the correct hyperlink of the affected section in the PR description and do not copy-paste the automated preview link. The change was made in the buildrun resource section but you have pasted a link for the Overview of builds section, which is incorrect. |
|
@Dhruv-Soni11 Thanks Dhruv. I have updated the PR with the correct preview link. |
|
@likhithj1996, for clarity purpose: It is not always necessary to put TaskRun or BuildRun in backticks. The cases where we want to refer these entities in generic manner, we can simply write task run or build run. You need to use backticks only when you refer those entities as objects or resources. for example, A You can refer to this link to see pipeline run instances that do not use backticks. I do not think we should put task run in backticks in this context. |
|
@likhithj1996: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
@likhithj1996, I would suggest to close this PR and the issue. There is no need to change anything in the task run formatting. |
| @@ -6,7 +6,7 @@ | |||
| [id="about-buildrun_{context}"] | |||
| = BuildRun resource | |||
|
|
|||
| A `BuildRun` resource invokes a build on your cluster, similar to any cluster job or Tekton task run. The `BuildRun` resource represents a workload on your cluster, which results in a running pod. A `BuildRun` is the running instance of a build. It instantiates a build for execution with specific parameters on a cluster. | |||
There was a problem hiding this comment.
@likhithj1996, here the TaskRun is referred in a generic way, that is, task run. So, no need to change its formatting. Please close the PR, the original formatting here is correct.
There was a problem hiding this comment.
Thanks for the explanation in simple and clear way. I agree and will be closing the PR and the JIRA ticket. Thank you.
Version(s):
builds-docs-1.1
andbuilds-docs-1.0Issue:
https://issues.redhat.com/browse/RHDEVDOCS-6154
Link to docs preview:
BuildRun Resource
QE review:
QE review:
SME review:
Peer review:
Internal Peer review: @Dhruv-Soni11
Additional information: